/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.deployment.impl;

import javax.xml.soap.SOAPMessage;

import cgl.narada.wsinfra.exception.ParsingException;
import cgl.narada.wsinfra.exception.ProcessingException;
import cgl.narada.wsinfra.schemas.addressing.ToDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.util.SoapEnvelopeConversion;
import cgl.narada.wsinfra.wsa.ParseWsaHeaders;
import cgl.narada.wsinfra.wsa.WsaProcessingFactory;

/** This is a utility class that can be used by OTHER implementations of the
    NetworkSubstrate interface. Specifically, this class takes a SOAPMessage
    and retrieves the contents of the [wsa:To] element, where wsa corresponds
    to the WS_Addressing schema.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:29 $
    $Revision: 1.4 $
*/

public class SoapMessageRouting {

  public static final SoapMessageRouting instance = new SoapMessageRouting();
  
  private SoapEnvelopeConversion soapEnvelopeConversion;
  private ParseWsaHeaders parseWsaHeaders;
  private String moduleName = "SoapRouting: ";

  private SoapMessageRouting() {
    soapEnvelopeConversion = SoapEnvelopeConversion.getInstance();
    parseWsaHeaders = WsaProcessingFactory.getParseWsaHeaders();
  }

  /** Retrieves the instance of this class. There will be one instance-per-JVM.
   */
  public static SoapMessageRouting getInstance() {
    return instance;
  }


  /** Computes the destination encapsulated by the [wsa:To] element. */
  public String computeDestination(SOAPMessage soapMessage) 
    throws ProcessingException {
    EnvelopeDocument envelopeDocument = 
      soapEnvelopeConversion.getEnvelopeDocument(soapMessage);
    if (envelopeDocument == null) {
      System.out.println(moduleName + "Converted Envelope document is NULL.");
    }

    String sendTo = getSendTo(envelopeDocument);

    return sendTo;
  }


  /** This method parses the envelopeDocument to look for the [wsa:To] 
      element. If one exists this method retrives the address element 
      from it and returns it as a String, if NOT it will return null. */
  private String getSendTo(EnvelopeDocument envelopeDocument) {
    String to = null;
    ToDocument toDocument = null;
    
    try {
      toDocument = parseWsaHeaders.getTo(envelopeDocument);
    } catch (ParsingException parseEx) {
      /** Ignore this exception. */
      System.out.println("Problems parsing the envelope" + parseEx.toString());
    }
    
    if (toDocument == null) {
      return to;
    }
    
    if (toDocument.getTo() == null) {
      return to;
    }
    
    to = toDocument.getTo().getStringValue();
    return to;
  }

}
